# List join requests for a group

Get a list of join requests for a group with optional filtering by status, username, and date range.
            Only group admins can access this endpoint

RBAC: requires GroupMembers.Manage

Endpoint: GET /api/v1/groups/{groupId}/join-requests
Version: 1.0
Security: header

## Query parameters:

  - `createdFrom` (string,null)
    Filter by creation date (start, like: 2025-01-01), inclusive
    Example: "2022-03-10"

  - `createdTo` (string,null)
    Filter by creation date (end, like: 2025-01-01), inclusive
    Example: "2022-03-10"

  - `lastId` (string,null)
    Get older records (records with IDs less than this value) Alias maxId/max_id
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `limit` (integer,null)

  - `offset` (integer,null)

  - `sortBy` (string,null)

  - `sortOrder` (string,null)
    Sort order. Supported values: ASC or DESC

  - `status` (string,null)
    Filter requests by status. If omitted, returns all requests.
    Enum: "PENDING", "APPROVED", "REJECTED"

  - `untilId` (string,null)
    Get newer records (records with IDs greater than this value) Alias minId/min_id
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `username` (string,null)
    Filter by username (case-insensitive exact match)

## Path parameters:

  - `groupId` (string, required)
    The unique identifier of the group
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

## Response 200 fields (application/json):

  - `requests` (array, required)
    Array of group join request objects

  - `requests.groupJoinRequestId` (string, required)
    Unique identifier for this group join request
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `requests.userId` (string, required)
    ID of the user requesting to join
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `requests.groupId` (string, required)
    ID of the group being requested to join
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `requests.username` (string, required)
    Username of the user requesting to join

  - `requests.displayName` (string, required)
    Display name of the user requesting to join

  - `requests.avatarId` (string,null)
    Avatar upload ID of the user
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `requests.answerToken` (string,null)
    Answer token from completing group questions (if questions were required)

  - `requests.status` (string, required)
    Current status of the join request
    Enum: "PENDING", "APPROVED", "REJECTED"

  - `requests.reason` (string,null)
    Reason provided for approval or rejection
    Example: "Approved - meets community guidelines"

  - `requests.createdAt` (string, required)
    When the join request was created
    Example: "2022-03-10T16:15:50Z"

  - `requests.updatedAt` (string, required)
    When the join request was last updated (status change, etc)
    Example: "2022-03-10T16:15:50Z"

  - `grandTotal` (integer, required)
    Total number of join requests for the specified group (no filters applied)

  - `total` (integer, required)
    Total number of join requests matching the applied filters

## Response 401 fields (application/json):

  - `errorCode` (string, required)
    Error code

  - `message` (string, required)
    Error message

  - `docUrl` (string)
    Link to documentation

## Response 403 fields (application/json):

  - `errorCode` (string, required)
    Error code

  - `message` (string, required)
    Error message

  - `docUrl` (string)
    Link to documentation

## Response 404 fields (application/json):

  - `errorCode` (string, required)
    Error code

  - `message` (string, required)
    Error message

  - `docUrl` (string)
    Link to documentation